home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / madwifi / net80211 / ieee80211_crypto.h < prev    next >
C/C++ Source or Header  |  2006-05-11  |  8KB  |  206 lines
  1. /*-
  2.  * Copyright (c) 2001 Atsushi Onoe
  3.  * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
  4.  * All rights reserved.
  5.  *
  6.  * Redistribution and use in source and binary forms, with or without
  7.  * modification, are permitted provided that the following conditions
  8.  * are met:
  9.  * 1. Redistributions of source code must retain the above copyright
  10.  *    notice, this list of conditions and the following disclaimer.
  11.  * 2. Redistributions in binary form must reproduce the above copyright
  12.  *    notice, this list of conditions and the following disclaimer in the
  13.  *    documentation and/or other materials provided with the distribution.
  14.  * 3. The name of the author may not be used to endorse or promote products
  15.  *    derived from this software without specific prior written permission.
  16.  *
  17.  * Alternatively, this software may be distributed under the terms of the
  18.  * GNU General Public License ("GPL") version 2 as published by the Free
  19.  * Software Foundation.
  20.  *
  21.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31.  *
  32.  * $Id: ieee80211_crypto.h 1441 2006-02-06 16:03:21Z mrenzmann $
  33.  */
  34. #ifndef _NET80211_IEEE80211_CRYPTO_H_
  35. #define _NET80211_IEEE80211_CRYPTO_H_
  36.  
  37. /*
  38.  * 802.11 protocol crypto-related definitions.
  39.  */
  40. #define    IEEE80211_KEYBUF_SIZE    16
  41. #define    IEEE80211_MICBUF_SIZE    (8 + 8)        /* space for both tx+rx keys */
  42. #define IEEE80211_TID_SIZE    17        /* total number of TIDs */
  43.  
  44. /*
  45.  * Old WEP-style key.  Deprecated.
  46.  */
  47. struct ieee80211_wepkey {
  48.     u_int wk_len;                /* key length in bytes */
  49.     u_int8_t wk_key[IEEE80211_KEYBUF_SIZE];
  50. };
  51.  
  52. struct ieee80211_cipher;
  53.  
  54. /*
  55.  * Crypto key state.  There is sufficient room for all supported
  56.  * ciphers (see below).  The underlying ciphers are handled
  57.  * separately through loadable cipher modules that register with
  58.  * the generic crypto support.  A key has a reference to an instance
  59.  * of the cipher; any per-key state is hung off wk_private by the
  60.  * cipher when it is attached.  Ciphers are automatically called
  61.  * to detach and cleanup any such state when the key is deleted.
  62.  *
  63.  * The generic crypto support handles encap/decap of cipher-related
  64.  * frame contents for both hardware- and software-based implementations.
  65.  * A key requiring software crypto support is automatically flagged and
  66.  * the cipher is expected to honor this and do the necessary work.
  67.  * Ciphers such as TKIP may also support mixed hardware/software
  68.  * encrypt/decrypt and MIC processing.
  69.  */
  70. /* XXX need key index typedef */
  71. /* XXX pack better? */
  72. /* XXX 48-bit rsc/tsc */
  73. struct ieee80211_key {
  74.     u_int8_t wk_keylen;        /* key length in bytes */
  75.     u_int8_t wk_flags;
  76. #define    IEEE80211_KEY_XMIT    0x01    /* key used for xmit */
  77. #define    IEEE80211_KEY_RECV    0x02    /* key used for recv */
  78. #define    IEEE80211_KEY_GROUP    0x04    /* key used for WPA group operation */
  79. #define    IEEE80211_KEY_SWCRYPT    0x10    /* host-based encrypt/decrypt */
  80. #define    IEEE80211_KEY_SWMIC    0x20    /* host-based enmic/demic */
  81.     u_int16_t wk_keyix;        /* key index */
  82.     u_int8_t wk_key[IEEE80211_KEYBUF_SIZE+IEEE80211_MICBUF_SIZE];
  83. #define    wk_txmic    wk_key+IEEE80211_KEYBUF_SIZE+0    /* XXX can't () right */
  84. #define    wk_rxmic    wk_key+IEEE80211_KEYBUF_SIZE+8    /* XXX can't () right */
  85.     u_int64_t wk_keyrsc[IEEE80211_TID_SIZE];    /* key receive sequence counter */
  86.     u_int64_t wk_keytsc;        /* key transmit sequence counter */
  87.     const struct ieee80211_cipher *wk_cipher;
  88.     void *wk_private;        /* private cipher state */
  89. };
  90. #define    IEEE80211_KEY_COMMON         /* common flags passed in by apps */\
  91.     (IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV | IEEE80211_KEY_GROUP)
  92.  
  93. /*
  94.  * NB: these values are ordered carefully; there are lots of
  95.  * of implications in any reordering.  In particular beware
  96.  * that 4 is not used to avoid conflicting with IEEE80211_F_PRIVACY.
  97.  */
  98. #define    IEEE80211_CIPHER_WEP        0
  99. #define    IEEE80211_CIPHER_TKIP        1
  100. #define    IEEE80211_CIPHER_AES_OCB    2
  101. #define    IEEE80211_CIPHER_AES_CCM    3
  102. #define    IEEE80211_CIPHER_CKIP        5
  103. #define    IEEE80211_CIPHER_NONE        6    /* pseudo value */
  104.  
  105. #define    IEEE80211_CIPHER_MAX        (IEEE80211_CIPHER_NONE+1)
  106.  
  107. #define    IEEE80211_KEYIX_NONE    ((u_int16_t) - 1)
  108.  
  109. #if defined(__KERNEL__) || defined(_KERNEL)
  110.  
  111. struct ieee80211com;
  112. struct ieee80211vap;
  113. struct ieee80211_node;
  114. struct sk_buff;
  115.  
  116. void ieee80211_crypto_attach(struct ieee80211com *);
  117. void ieee80211_crypto_detach(struct ieee80211com *);
  118. void ieee80211_crypto_vattach(struct ieee80211vap *);
  119. void ieee80211_crypto_vdetach(struct ieee80211vap *);
  120. int ieee80211_crypto_newkey(struct ieee80211vap *, int, int,
  121.     struct ieee80211_key *);
  122. int ieee80211_crypto_delkey(struct ieee80211vap *, struct ieee80211_key *,
  123.     struct ieee80211_node *);
  124. int ieee80211_crypto_setkey(struct ieee80211vap *, struct ieee80211_key *,
  125.     const u_int8_t macaddr[IEEE80211_ADDR_LEN], struct ieee80211_node *);
  126. void ieee80211_crypto_delglobalkeys(struct ieee80211vap *);
  127.  
  128. /*
  129.  * Template for a supported cipher.  Ciphers register with the
  130.  * crypto code and are typically loaded as separate modules
  131.  * (the null cipher is always present).
  132.  * XXX may need refcnts
  133.  */
  134. struct ieee80211_cipher {
  135.     const char *ic_name;        /* printable name */
  136.     u_int ic_cipher;            /* IEEE80211_CIPHER_* */
  137.     u_int ic_header;            /* size of privacy header (bytes) */
  138.     u_int ic_trailer;        /* size of privacy trailer (bytes) */
  139.     u_int ic_miclen;            /* size of mic trailer (bytes) */
  140.     void *(*ic_attach)(struct ieee80211vap *, struct ieee80211_key *);
  141.     void (*ic_detach)(struct ieee80211_key *);
  142.     int (*ic_setkey)(struct ieee80211_key *);
  143.     int (*ic_encap)(struct ieee80211_key *, struct sk_buff *, u_int8_t);
  144.     int (*ic_decap)(struct ieee80211_key *, struct sk_buff *, int);
  145.     int (*ic_enmic)(struct ieee80211_key *, struct sk_buff *, int);
  146.     int (*ic_demic)(struct ieee80211_key *, struct sk_buff *, int);
  147. };
  148. extern const struct ieee80211_cipher ieee80211_cipher_none;
  149.  
  150. void ieee80211_crypto_register(const struct ieee80211_cipher *);
  151. void ieee80211_crypto_unregister(const struct ieee80211_cipher *);
  152. int ieee80211_crypto_available(u_int);
  153.  
  154. struct ieee80211_key *ieee80211_crypto_encap(struct ieee80211_node *,
  155.     struct sk_buff *);
  156. struct ieee80211_key *ieee80211_crypto_decap(struct ieee80211_node *,
  157.     struct sk_buff *, int);
  158.  
  159. /*
  160.  * Check and remove any MIC.
  161.  */
  162. static __inline int
  163. ieee80211_crypto_demic(struct ieee80211vap *vap, struct ieee80211_key *k,
  164.     struct sk_buff *skb, int hdrlen)
  165. {
  166.     const struct ieee80211_cipher *cip = k->wk_cipher;
  167.     return (cip->ic_miclen > 0 ? cip->ic_demic(k, skb, hdrlen) : 1);
  168. }
  169.  
  170. /*
  171.  * Add any MIC.
  172.  */
  173. static __inline int
  174. ieee80211_crypto_enmic(struct ieee80211vap *vap, struct ieee80211_key *k,
  175.     struct sk_buff *skb, int force)
  176. {
  177.     const struct ieee80211_cipher *cip = k->wk_cipher;
  178.     return (cip->ic_miclen > 0 ? cip->ic_enmic(k, skb, force) : 1);
  179. }
  180.  
  181. /* 
  182.  * Reset key state to an unused state.  The crypto
  183.  * key allocation mechanism ensures other state (e.g.
  184.  * key data) is properly setup before a key is used.
  185.  */
  186. static __inline void
  187. ieee80211_crypto_resetkey(struct ieee80211vap *vap, struct ieee80211_key *k,
  188.     u_int16_t ix)
  189. {
  190.     k->wk_cipher = &ieee80211_cipher_none;;
  191.     k->wk_private = k->wk_cipher->ic_attach(vap, k);
  192.     k->wk_keyix = ix;
  193.     k->wk_flags = IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV;
  194. }
  195.  
  196. /*
  197.  * Crypto-related notification methods.
  198.  */
  199. void ieee80211_notify_replay_failure(struct ieee80211vap *,
  200.     const struct ieee80211_frame *, const struct ieee80211_key *,
  201.     u_int64_t rsc);
  202. void ieee80211_notify_michael_failure(struct ieee80211vap *,
  203.     const struct ieee80211_frame *, u_int keyix);
  204. #endif /* defined(__KERNEL__) || defined(_KERNEL) */
  205. #endif /* _NET80211_IEEE80211_CRYPTO_H_ */
  206.